API Documentation
BufferView.h
1 // BufferView.h
3 //
5 
6 namespace nkMemory
7 {
16  template <typename T = unsigned char>
17  class BufferView
18  {
19  public :
20 
21  // Constructors, destructor
25  BufferView () noexcept ;
33  BufferView (T* data, unsigned long long size) noexcept ;
40  BufferView (const Buffer& buffer) noexcept ;
49  BufferView (const Buffer& buffer, unsigned long long index, unsigned long long length = 0) noexcept ;
56  BufferView (Buffer&& buffer) = delete ;
61  ~BufferView () noexcept = default ;
62 
63  public :
64 
65  // Getters
69  T* getData () const ;
73  unsigned long long getSize () const ;
77  bool empty () const ;
81  T& front () ;
85  const T& front () const ;
89  T& back () ;
93  const T& back () const ;
97  T* begin () ;
101  const T* begin () const ;
105  T* end () ;
109  const T* end () const ;
110 
111  public :
112 
113  // Conversions
121  BufferView<T> subView (unsigned long long index, unsigned long long length = 0) const ;
122 
123  public :
124 
125  // Operators
132  T& operator[] (unsigned long long index) ;
139  const T& operator[] (unsigned long long index) const ;
140 
141  public :
142 
143  // Constructors templated
149  template <typename U>
150  BufferView (BufferCast<U>& bufferCast) noexcept ;
156  BufferView (BufferCast<T>& bufferCast) noexcept ;
162  template <typename U>
163  BufferView (const BufferView<U>& view) noexcept ;
169  BufferView (const BufferView<T>& view) noexcept ;
175  BufferView (BufferView<T>&& other) noexcept ;
181  template <typename U, std::size_t S>
182  BufferView (std::array<U, S>& array) noexcept ;
188  template <std::size_t S>
189  BufferView (std::array<T, S>& array) noexcept ;
195  template <typename U>
196  BufferView (std::vector<U>& vec) noexcept ;
202  BufferView (std::vector<T>& vec) noexcept ;
203 
211  template <typename U, std::size_t S, typename = std::enable_if<std::is_const<T>::value>>
212  BufferView (const std::array<U, S>& array) noexcept ;
220  template <std::size_t S, typename = std::enable_if<std::is_const<T>::value>>
221  BufferView (const std::array<typename std::remove_const<T>::type, S>& array) noexcept ;
229  template <typename U, typename = std::enable_if<std::is_const<T>::value>>
230  BufferView (const std::vector<U>& vec) noexcept ;
238  template <typename = std::enable_if<std::is_const<T>::value>>
239  BufferView (const std::vector<typename std::remove_const<T>::type>& vec) noexcept ;
240 
241  public :
242 
243  // Conversion operators
248  operator Buffer () const ;
249 
254  template <typename T>
255  operator BufferCast<T> () const ;
256  } ;
257 }
nkMemory::BufferView::end
T * end()
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkMemory::BufferView::begin
T * begin()
nkMemory::BufferView::getData
T * getData() const
nkMemory::BufferView::back
T & back()
nkMemory::BufferView::getSize
unsigned long long getSize() const
nkMemory::Buffer
A buffer holding binary data.
Definition: Buffer.h:32
nkMemory::BufferView::BufferView
BufferView() noexcept
nkMemory::BufferCast
Holds a Buffer and make it easy to cast the binary data.
Definition: BufferCast.h:18
nkMemory::BufferView::empty
bool empty() const
nkMemory::BufferView::front
T & front()
nkMemory::BufferView::subView
BufferView< T > subView(unsigned long long index, unsigned long long length=0) const
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7